feat: added C implementation for `math/base/special/sici` #8187

navyansh007 · 2025-10-02T12:02:05Z

resolves #7524

Read, understood, and followed the [contributing guidelines][contributing].

--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: passed - task: lint_c_benchmarks status: passed - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---

stdlib-bot · 2025-10-02T12:03:56Z

Coverage Report

Package	Statements	Branches	Functions	Lines
math/base/special/sici	$\color{green}874/874$ $color{green}+100.00%$	$\color{green}72/72$ $color{green}+100.00%$	$\color{green}14/14$ $color{green}+100.00%$	$\color{green}874/874$ $color{green}+100.00%$

The above coverage report was generated for the changes in this PR.

--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---

lib/node_modules/@stdlib/math/base/special/sici/src/main.c

--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: passed - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---

lib/node_modules/@stdlib/math/base/special/sici/manifest.json

Signed-off-by: Gunj Joshi <[email protected]>

gunjjoshi · 2025-10-27T11:57:34Z

@navyansh007 You'll need to update README.md, which is currently missing from this PR. For reference, you can have a look at this as an example.

gunjjoshi · 2025-10-27T12:00:49Z

lib/node_modules/@stdlib/math/base/special/sici/src/main.c

+	}
+
+	*si = s;
+	*ci = STDLIB_CONSTANT_FLOAT64_EULERGAMMA + log( ax ) + c;


@navyansh007 You can use @stdlib/math/base/special/ln here, instead of using log() from math.h.

navyansh007 · 2025-10-28T00:25:30Z

Thanks for your feedback @gunjjoshi. Going to work on all of those feedbacks.

--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: missing_dependencies - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---

--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: passed - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: na - task: lint_license_headers status: passed ---

navyansh007 · 2025-10-29T04:16:10Z

Hey @kgryte @gunjjoshi
I have implemented all the changes suggested by @gunjjoshi in the sici function's C implementation. Feel free to let me know if any further modifications are required.

gunjjoshi · 2025-10-30T16:42:47Z

lib/node_modules/@stdlib/math/base/special/sici/manifest.json

+        "@stdlib/math/base/special/cos",
+        "@stdlib/math/base/special/sin",


Suggested change

"@stdlib/math/base/special/cos",

"@stdlib/math/base/special/sin",

We do not need these now, as we're using stdlib_base_sincos.

gunjjoshi · 2025-10-30T16:43:13Z

lib/node_modules/@stdlib/math/base/special/sici/manifest.json

+        "@stdlib/math/base/special/cos",
+        "@stdlib/math/base/special/sin",


Suggested change

"@stdlib/math/base/special/cos",

"@stdlib/math/base/special/sin",

gunjjoshi · 2025-10-30T16:43:30Z

lib/node_modules/@stdlib/math/base/special/sici/manifest.json

+        "@stdlib/math/base/special/cos",
+        "@stdlib/math/base/special/sin",


Suggested change

"@stdlib/math/base/special/cos",

"@stdlib/math/base/special/sin",

gunjjoshi · 2025-10-30T16:58:31Z

lib/node_modules/@stdlib/math/base/special/sici/scripts/evalpoly.js

 		'encoding': 'utf8'
 	};

+	// Generate JavaScript files:


Suggested change

// Generate JavaScript files:

Let's not keep this, as none of the other packages such as exp, atan, etc. have such comments. The initialization of opts and copts should be enough to have a visual separation between the generation of JS and C files.

gunjjoshi · 2025-10-30T16:58:44Z

lib/node_modules/@stdlib/math/base/special/sici/scripts/evalpoly.js

 	str = header + compile( GD8 );
 	writeFileSync( fpath, str, opts );
+
+	// Generate C files:


Suggested change

// Generate C files:

gunjjoshi · 2025-10-30T17:22:46Z

lib/node_modules/@stdlib/math/base/special/sici/src/main.c

+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/


Suggested change

*/

*

*

* ## Notice

*

* The original C code, long comment, copyright, license, and constants are from [Cephes]{@link http://www.netlib.org/cephes}. The implementation follows the original, but has been modified according to project conventions.

*

* ```text

* Copyright 1984, 1987, 1989 by Stephen L. Moshier

*

* Some software in this archive may be from the book _Methods and Programs for Mathematical Functions_ (Prentice-Hall or Simon & Schuster International, 1989) or from the Cephes Mathematical Library, a commercial product. In either event, it is copyrighted by the author. What you see here may be used freely but it comes with no support or guarantee.

*

* Stephen L. Moshier

* moshier@na-net.ornl.gov

* ```

*/

Let's preserve the full header comment from main.js.

gunjjoshi · 2025-10-30T17:25:39Z

@navyansh007 Would you mind replacing the use of sin and cos in main.js by sincos as well, as per #8187 (comment)?

gunjjoshi · 2025-10-30T17:30:50Z

lib/node_modules/@stdlib/math/base/special/sici/src/main.c

+* @param si    output pointer for sine integral
+* @param ci    output pointer for cosine integral


Suggested change

* @param si output pointer for sine integral

* @param ci output pointer for cosine integral

* @param si destination to store the sine integral

* @param ci destination to store the cosine integral

Following what we have in sincos: https://github.com/stdlib-js/stdlib/blob/develop/lib/node_modules/%40stdlib/math/base/special/sincos/src/main.c#L97

gunjjoshi · 2025-10-30T17:36:53Z

lib/node_modules/@stdlib/math/base/special/sici/src/main.c

+* stdlib_base_sici( 3.0, &si, &ci );
+*/
+void stdlib_base_sici( const double x, double *si, double *ci ) {
+	double sgn;


I think we can keep sgn as an 8 bit integer, instead of declaring it as double.

And that would then require us to make changes at all other places in this function which use sgn, such as replacing sgn = -1.0 by sgn = -1. The cephes implementation too, doesn't keep sgn as double.

stdlib-bot added Math Issue or pull request specific to math functionality. Needs Review A pull request which needs code review. labels Oct 2, 2025

kgryte changed the title ~~feat: added C implementation for math/base/special/sici~~ feat: added C implementation for math/base/special/sici Oct 2, 2025

kgryte requested a review from anandkaranubc October 2, 2025 19:46

kgryte reviewed Oct 2, 2025

View reviewed changes

lib/node_modules/@stdlib/math/base/special/sici/src/main.c Outdated Show resolved Hide resolved

gunjjoshi reviewed Oct 10, 2025

View reviewed changes

lib/node_modules/@stdlib/math/base/special/sici/manifest.json Show resolved Hide resolved

gunjjoshi reviewed Oct 10, 2025

View reviewed changes

lib/node_modules/@stdlib/math/base/special/sici/manifest.json Outdated Show resolved Hide resolved

gunjjoshi reviewed Oct 10, 2025

View reviewed changes

lib/node_modules/@stdlib/math/base/special/sici/manifest.json Outdated Show resolved Hide resolved

gunjjoshi reviewed Oct 10, 2025

View reviewed changes

lib/node_modules/@stdlib/math/base/special/sici/manifest.json Outdated Show resolved Hide resolved

gunjjoshi added 3 commits October 10, 2025 10:27

Apply suggestions from code review

7af262a

Signed-off-by: Gunj Joshi <[email protected]>

add new directories

29208e6

Signed-off-by: Gunj Joshi <[email protected]>

Update package.json

d25071f

Signed-off-by: Gunj Joshi <[email protected]>

gunjjoshi reviewed Oct 27, 2025

View reviewed changes

navyansh007 and others added 3 commits October 29, 2025 09:34

Merge branch 'stdlib-js:develop' into sici-c-implementation

7ca21aa

gunjjoshi self-requested a review October 29, 2025 04:16

gunjjoshi reviewed Oct 30, 2025

View reviewed changes

gunjjoshi added Needs Changes Pull request which needs changes before being merged. and removed Needs Review A pull request which needs code review. labels Oct 30, 2025

		"@stdlib/math/base/special/cos",
		"@stdlib/math/base/special/sin",

-*/
+*
+*
+* ## Notice
+*
+* The original C code, long comment, copyright, license, and constants are from [Cephes]{@link http://www.netlib.org/cephes}. The implementation follows the original, but has been modified according to project conventions.
+*
+* ```text
+* Copyright 1984, 1987, 1989 by Stephen L. Moshier
+*
+* Some software in this archive may be from the book _Methods and Programs for Mathematical Functions_ (Prentice-Hall or Simon & Schuster International, 1989) or from the Cephes Mathematical Library, a commercial product. In either event, it is copyrighted by the author. What you see here may be used freely but it comes with no support or guarantee.
+*
+* Stephen L. Moshier
+* moshier@na-net.ornl.gov
+* ```
+*/

		* @param si output pointer for sine integral
		* @param ci output pointer for cosine integral

Uh oh!

feat: added C implementation for math/base/special/sici #8187

Are you sure you want to change the base?

feat: added C implementation for math/base/special/sici #8187

Conversation

navyansh007 commented Oct 2, 2025

Uh oh!

stdlib-bot commented Oct 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Coverage Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

gunjjoshi commented Oct 27, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

navyansh007 commented Oct 28, 2025

Uh oh!

navyansh007 commented Oct 29, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gunjjoshi commented Oct 30, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

feat: added C implementation for `math/base/special/sici` #8187

feat: added C implementation for `math/base/special/sici` #8187

stdlib-bot commented Oct 2, 2025 •

edited

Loading